The REST API Sample Clients

The REST API package includes a sample Python client and a sample Web client. These sample clients primarily serve as test tools to demonstrate interactions between the REST framework and communicating appliances. They are especially useful for new users .

The clients are organized to make running calls simple. They automate some of the more time-consuming tasks associated with manual queries, making REST interactions efficient. The client's clear and minimalistic layout allows new users to easily interact with the API, but keeps a custom query tab for those more familiar with its resources.

Calls are grouped under tabs representing different services a user may communicate with. User requests and responses are tracked in an output window at the bottom of the interface, making it easy to parse output and make decisions.

NOTE   Detailed structural information and schemata of the resources referenced in this document can be found in the REST API Command Reference documentation.

This section outlines the following:

>Sample Workflow

>Using the Python Client

>Using the Web Client